NAVNavbar
Logo
cURL php NodeJS Python cSharp

Google Play Bulk App Metrics Live


This endpoint will provide you with ranking metrics for up to 1000 Google Play applications.

The returned results are specific to the app_id specified in a POST request.

The app_id parameter can be found on the Google Play website as a part of a URL pointing to a specific mobile application. For example, here is the URL of the Telegram app on Google Play:

https://play.google.com/store/apps/details?id=org.telegram.messenger

The app_id of this app is org.telegram.messenger

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
	"app_ids" => [
            "org.telegram.messenger",
            "com.zhiliaoapp.musically"
        ],
	"language_name" => "English",
	"location_code" => 2840,
	"limit" => 10
);
try {
   // POST /v3/dataforseo_labs/bulk_app_metrics/live
   $result = $client->post('/v3/dataforseo_labs/google/bulk_app_metrics/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20220428",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.2718 sec.",
    "cost": 0.0102,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "06241830-2806-0453-0000-909a16f19234",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.1868 sec.",
            "cost": 0.0102,
            "result_count": 1,
            "path": [
                "v3",
                "dataforseo_labs",
                "google",
                "bulk_app_metrics",
                "live"
            ],
            "data": {
                "api": "dataforseo_labs",
                "function": "bulk_app_metrics",
                "se_type": "google",
                "app_ids": [
                    "org.telegram.messenger",
                    "com.zhiliaoapp.musically"
                ],
                "location_code": 2840,
                "language_code": "en"
            },
            "result": [
                {
                    "se_type": "google",
                    "location_code": 2840,
                    "language_code": "en",
                    "total_count": 2,
                    "items_count": 2,
                    "items": [
                        {
                            "se_type": "google",
                            "app_id": "com.zhiliaoapp.musically",
                            "metrics": {
                                "google_play_search_organic": {
                                    "pos_1": 11239,
                                    "pos_2_3": 3637,
                                    "pos_4_10": 3983,
                                    "pos_11_100": 6844,
                                    "count": 25703,
                                    "search_volume": 3716329
                                }
                            }
                        },
                        {
                            "se_type": "google",
                            "app_id": "org.telegram.messenger",
                            "metrics": {
                                "google_play_search_organic": {
                                    "pos_1": 1351,
                                    "pos_2_3": 547,
                                    "pos_4_10": 2023,
                                    "pos_11_100": 3717,
                                    "count": 7638,
                                    "search_volume": 1070587
                                }
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
app_ids array ids of the app
required field
IDs of the mobile applications on Google Play;
you can find the ID in the URL of every app listed on Google Play;
example:
in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger
the id is org.telegram.messenger;
the maximum number of IDs you can specify in this field is 1000
location_name string full name of the location
required field if you don’t specify location_code
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:
United States
location_code integer location code
required field if you don’t specify location_name
Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the US location only;
example:
2840
language_name string full name of the language
required field if you don’t specify language_code
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only;
example:
English
language_code string language code
required field if you don’t specify language_name
Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
Note: this endpoint currently supports the English language only
example:
en
tag string user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response

As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            se_type string search engine type
            app_id string id of the app in a POST array
            location_code integer location code in a POST array
            language_code string language code in a POST array
            total_count integer total amount of results in our database relevant to your request
            items_count integer the number of results returned in the items array
            items array contains data related to the ranking app metrics of the specified application
                se_type string search engine type
                app_id string id of the app in a POST array
                metrics object metrics for the ranking keywords of the app
ranking data relevant to the keywords that the provided application ranks for on Google Play
                    google_play_search_organic object ranking data from Google Play organic search
                        pos_1 integer number of SERPs where the app ranks #1 in organic results
                        pos_2_3 integer number of SERPs where the app ranks #2-3 in organic results
                        pos_4_10 integer number of SERPs where the app ranks #4-10 in organic results
                        pos_11_100 integer number of SERPs where the app ranks #11-100 in organic results
                        count integer total count of organic SERPs that contain the app
                        search_volume integer total search volume of the app’s ranking keywords in Google Play organic SERP

‌‌